.TH E1432_SET_OCTAVE_MODE 3 E1432
.SH NAME
.nf
e1432_set_octave_mode \- Set Octave measurement mode
e1432_get_octave_mode \- Get Octave measurement mode
.IX e1432_set_octave_mode(3) 3
.IX e1432_get_octave_mode(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_octave_mode(E1432ID hw, SHORTSIZ16 ID,
                                 SHORTSIZ16 octave_mode)
SHORTSIZ16 e1432_get_octave_mode(E1432ID hw, SHORTSIZ16 ID,
                                 SHORTSIZ16 *octave_mode)
.cE
.SH DESCRIPTION

\fIe1432_set_octave_mode\fR sets the octave mode of the modules(s) selected
to the value given in \fIoctave_mode\fR.

\fIe1432_get_octave_mode\fR returns the octave mode state of the modules(s)
selected into a memory location pointed to by \fIoctave_mode\fR.

This parameter is a "global" parameter.  It applies to an entire
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.
It is used to determine which module(s) in \fIhw\fR to set/query.

\fIoctave_mode\fR must be either
\fBE1432_OCTAVE_MODE_FULL\fR or \fBE1432_OCTAVE_MODE_THIRD\fR.
\fBE1432_OCTAVE_MODE_FULL\fR selects full (1/1) Octave measurements.
\fBE1432_OCTAVE_MODE_THIRD\fR selects third (1/3) Octave measurements.

.SH "RESET VALUE"
After a reset, \fIoctave_mode\fR is set to \fBE1432_OCTAVE_MODE_THIRD\fR.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_octave_meas,
e1432_set_octave_avg_mode,
e1432_set_octave_hold_mode,
e1432_set_octave_start_freq, e1432_set_octave_stop_freq,
e1432_set_octave_int_time,
e1432_set_octave_time_const,
e1432_set_octave_time_step,
e1432_octave_ctl,
e1432_get_octave_blocksize,
e1432_get_current_data,
e1432_set_trigger_delay
.ad
